Overview

Normally, when we specify the host of an API, we do so like this:

{
    "host": "example.com",
    "port": 1234,
    "secure": false
}

If we specify both the protocol and the port in the host variable, it makes the sdk behave in unexpected ways. For example:

{
    "host": "http://example.com:1234"
    // secure is true by default
}

All the requests would go to https://http://example.com:1234:443.

Using Node's url module, we parse the url, and if a protocol/port are found, we override the default ones.

// input:
{
    "host": "http://example.com:1234"
}

// output:
{
    "host": "example.com",
    "port": 1234,
    "secure": false
}

This change is made with backward compatibility in mind. If the host we provide is just the hostname, the sdk behaves like normal.

Flaws

If we specify a host with a port but not a protocol:

{
    "host": "example.com:1234"
}

Node's url parser thinks the protocol is example.com: and that the hostname is '', which would default to localhost.

Todo

• If a host is provided with a port but not a protocol, should we prepend the protocol to the host based on the secure flag?